<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>NVTX C API Reference: nvtxPayloadData_t Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr id="projectrow">
  <td id="projectalign">
   <div id="projectname">NVTX C API Reference<span id="projectnumber">&#160;v3</span>
   </div>
   <div id="projectbrief">NVIDIA Tools Extension Library</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>

</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-attribs">Data Fields</a>  </div>
  <div class="headertitle"><div class="title">nvtxPayloadData_t Struct Reference</div></div>
</div><!--header-->
<div class="contents">

<p>Binary payload data, size and decoding information.  
 <a href="structnvtx_payload_data__t.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="nv_tools_ext_payload_8h_source.html">nvToolsExtPayload.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:acc85b71f0d3a63e54ebc779f48df8309" id="r_acc85b71f0d3a63e54ebc779f48df8309"><td class="memItemLeft" align="right" valign="top">uint64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structnvtx_payload_data__t.html#acc85b71f0d3a63e54ebc779f48df8309">schemaId</a></td></tr>
<tr class="separator:acc85b71f0d3a63e54ebc779f48df8309"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad0f0648c8ec5854b2cda3aa6e2f5dae5" id="r_ad0f0648c8ec5854b2cda3aa6e2f5dae5"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structnvtx_payload_data__t.html#ad0f0648c8ec5854b2cda3aa6e2f5dae5">size</a></td></tr>
<tr class="separator:ad0f0648c8ec5854b2cda3aa6e2f5dae5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad4ecf00bae9cf3ccd26b75b20cc38019" id="r_ad4ecf00bae9cf3ccd26b75b20cc38019"><td class="memItemLeft" align="right" valign="top">const void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structnvtx_payload_data__t.html#ad4ecf00bae9cf3ccd26b75b20cc38019">payload</a></td></tr>
<tr class="separator:ad4ecf00bae9cf3ccd26b75b20cc38019"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Binary payload data, size and decoding information. </p>
<p>An array of type <code><a class="el" href="structnvtx_payload_data__t.html" title="Binary payload data, size and decoding information.">nvtxPayloadData_t</a></code> is passed to the NVTX event attached to an NVTX event via the <code>payload.ullvalue</code> field of NVTX event attributes.</p>
<p>The <code>schemaId</code> be a predefined schema entry type (<code>NVTX_PAYLOAD_ENTRY_TYPE*</code>), a schema ID (statically specified or dynamically created) or one of <code>NVTX_PAYLOAD_TYPE_REFERENCED</code> or <code>NVTX_PAYLOAD_TYPE_RAW</code>.</p>
<p>Setting the size of a payload to <code>MAX_SIZE</code> can be useful to reduce the overhead of NVTX instrumentation, when no NVTX handler is attached. However, a tool might not be able to detect the size of a payload and thus skip it. A reasonable use case is a payload that represents a null-terminated C string, where the NVTX handler can call <code>strlen()</code>. </p>

<p class="definition">Definition at line <a class="el" href="nv_tools_ext_payload_8h_source.html#l00624">624</a> of file <a class="el" href="nv_tools_ext_payload_8h_source.html">nvToolsExtPayload.h</a>.</p>
</div><h2 class="groupheader">Field Documentation</h2>
<a id="ad4ecf00bae9cf3ccd26b75b20cc38019" name="ad4ecf00bae9cf3ccd26b75b20cc38019"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad4ecf00bae9cf3ccd26b75b20cc38019">&#9670;&#160;</a></span>payload</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const void* nvtxPayloadData_t::payload</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Pointer to the binary payload data. </p>

<p class="definition">Definition at line <a class="el" href="nv_tools_ext_payload_8h_source.html#l00640">640</a> of file <a class="el" href="nv_tools_ext_payload_8h_source.html">nvToolsExtPayload.h</a>.</p>

</div>
</div>
<a id="acc85b71f0d3a63e54ebc779f48df8309" name="acc85b71f0d3a63e54ebc779f48df8309"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acc85b71f0d3a63e54ebc779f48df8309">&#9670;&#160;</a></span>schemaId</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint64_t nvtxPayloadData_t::schemaId</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>The schema ID, which defines the layout of the binary data. </p>

<p class="definition">Definition at line <a class="el" href="nv_tools_ext_payload_8h_source.html#l00629">629</a> of file <a class="el" href="nv_tools_ext_payload_8h_source.html">nvToolsExtPayload.h</a>.</p>

</div>
</div>
<a id="ad0f0648c8ec5854b2cda3aa6e2f5dae5" name="ad0f0648c8ec5854b2cda3aa6e2f5dae5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad0f0648c8ec5854b2cda3aa6e2f5dae5">&#9670;&#160;</a></span>size</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">size_t nvtxPayloadData_t::size</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Size of the payload (blob) in bytes. <code>SIZE_MAX</code> (<code>-1</code>) indicates the tool that it should figure out the size, which might not be possible. </p>

<p class="definition">Definition at line <a class="el" href="nv_tools_ext_payload_8h_source.html#l00635">635</a> of file <a class="el" href="nv_tools_ext_payload_8h_source.html">nvToolsExtPayload.h</a>.</p>

</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="nv_tools_ext_payload_8h_source.html">nvToolsExtPayload.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
</small></address>
</body>
</html>
